| MFMI_MT700711CA Registry Request Wrapper - Human Initiated With Role Payload |
Derived from RMIM: _ and HMD: _ |
||||||||
| ControlActEvent |
Design Comments: Identifies the action that resulted in this message being sent. UsageNotes: There may be constraints on the usage of the effectiveTime and reasonCode attributes in the definition of the interaction or the trigger events which are conveyed with this wrapper. Rationale: Key to understanding what action a message represents. |
||||||||
| classCode [1..1] (M) ControlAct (CS) {CNE:C:ActClass:CACT, fixed value= "CACT"} |
|||||||||
| moodCode [1..1] (M) ControlAct (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| id [1..1] (M) ControlAct (II.BUS) |
Design Comments: A unique identifier for this particular event assigned by the system in which the event occurred. UsageNotes: Identifier needs to be persisted by receiving applications, except for queries (queries cannot be retracted or undone). The identifier must be unique and different from the event identifier that is present on the request - it must be generated by the responding application. Rationale: Allows the event to be referenced (for undos) and also indicates whether multiple interactions were caused by the same triggering event. Also used for audit purposes. |
||||||||
| code [1..1] (M) ControlAct (CV) {CNE:D:HL7TriggerEventCode} |
Design Comments: Identifies the trigger event that occurred. Rationale: This is mandatory because it is essential to understanding the meaning of the event. |
||||||||
| statusCode [1..1] (M) ControlAct (CS) {CNE:C:ActStatus:completed, fixed value= "completed"} |
Design Comments: Describes the status of the control act, which is always complete (it happened). Rationale: Required for completeness of specification. |
||||||||
| effectiveTime [0..1] ControlAct (IVL<TS.FULLDATEWITHTIME>) |
Design Comments: Indicates the time the event (e.g. query, change, activation) should begin and occasionally when it should end. Rationale: The time an event becomes effective may differ from the time the event is recorded (i.e. it may be in the future or the past). For events such as 'suspend', an intended end date may also be indicated. |
||||||||
| reasonCode [0..1] ControlAct (CV) {CWE:D:ControlActReason} |
Design Comments: Identifies why this specific message interaction (e.g. query, activation request, modification request) occurred. UsageNotes: The domain associated with this attribute will vary for each interaction and will be noted as part of the interaction description. Rationale: Allows identifying a reason for a specific action, such as 'reason for hold' or 'reason for accessing information'. |
||||||||
| languageCode [0..1] ControlAct (CE) {CNE:D:HumanLanguage} |
|||||||||
| responsibleParty [0..1] (ResponsibleParty) |
Design Comments: Allows for the trail of responsibility for the action. The association is optional because in some jurisdictions, the supervisor may be conveyed by he authentication token. Rationale: If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
||||||||
| author [1..1] (Author) |
Design Comments: Indicates the person responsible for the event that caused this message. Rationale: Critical for auditing and for validating permissions and therefore mandatory. |
||||||||
| dataEnterer [0..1] (DataEnterer) |
Design Comments: Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. UsageNotes: This should only be specified if different from the author. Rationale: Important for audit information and determining permissions.
The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. |
||||||||
| dataEntryLocation [0..1] (DataEntryLocation) |
Design Comments: Indicates the location where the record of this event was entered. UsageNotes: This should only be specified if different from the location where the event was authored. Rationale: Indicates a potential location for written records, and may also be important for authentication purposes.
The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. |
||||||||
| location [0..1] (Location) |
Design Comments: Indicates the service delivery location where the event occurred. Rationale: Indicates where paper records may be located, and may be important to determining authorization.
The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. |
||||||||
| subject [1..1] (Subject2) |
Design Comments: Indicates the item(s) being acted upon by this trigger event.
Will be mandatory in wrappers with payload messages, otherwise not present. UsageNotes: If there are multiple subject items, the changes to all of them must be either accepted or rejected as a single action. I.e. One trigger event = 1 unit of work. Rationale: Provides information about the thing being created, modified or removed. |
||||||||
| pertinentInformation [0..1] (PertinentInformation) |
Design Comments: Identifies the authentication token that references information about the people and/or places responsible for the event. Rationale: Some systems perform centralized authentication of providers and/or locations. The association is optional because not all systems will make use of a token-based authentication process. |
||||||||
| subjectOf1 [0..1] (Subject3) |
Design Comments: Information pertaining to a client's (or provider's)agreement/acceptance to have his/her client/provider identification and demographic information electronically stored and shared. Rationale: Provides authorization to record and/or view client/provider information.
Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis. |
||||||||
| subjectOf2 [0..50] (Subject) |
Design Comments: This is the list of clinical and business issues that have been detected and/or managed involving the current action. Rationale: Any trigger event can result in errors or may allow for errors to be overridden or managed. |
||||||||
| ResponsibleParty [Constraint: "
If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. "] |
Design Comments: Allows for the trail of responsibility for the action. The association is optional because in some jurisdictions, the supervisor may be conveyed by he authentication token. Rationale: If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:RESP, fixed value= "RESP"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| assignedEntity [1..1] (R_AssignedPersonIdentified-confirmable) | |||||||||
| Author [Constraint: "
If AuthorizationToken is specified and communicates author, the bare AuthorRole class must be specified, otherwise (R_AssignedPerson CMET or R_AssignedOrganization) must be specified. "] |
Design Comments: Indicates the person responsible for the event that caused this message. Rationale: Critical for auditing and for validating permissions and therefore mandatory. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:AUT, fixed value= "AUT"} |
UsageNotes: Value should always be AUT |
||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| time [1..1] (M) Participation (TS.FULLDATETIME) |
Design Comments: The time the person responsible for the event made the decision for it to occur. This may be different than the time the change became effective. (E.g. If a provider decides today to put a prescription on hold starting next Tuesday, the time of creation would be today and the change effective period would be next Tuesday.)
This date can be back-dated. Rationale: The time a change is made is a critical piece of audit information and is therefore mandatory. |
||||||||
| modeCode [0..1] Participation (CV) {CNE:D:ParticipationMode} |
Design Comments: Indicates how the person who recorded the event became aware of it.. E.g. Verbal, written, fax, etc. Rationale: May have ramifications for the audit trail and reliability of the information. |
||||||||
| signatureText [0..1] Participation (ED.SIGNATURE) |
Design Comments: Indicates the formal digital signature of the message content. Rationale: Digital signatures may be needed for authentication of message content. The attribute is marked as optional because it is not yet clear whether there is a use-case for this, or where it will be used. |
||||||||
| authorPerson [1..1] (AuthorPerson) | |||||||||
| AuthorPerson | |||||||||
| choice of AuthorRole |
Rationale: This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token. |
||||||||
| or R_AssignedPersonIdentified-confirmable | |||||||||
| or R_AssigningOrganizationIdentified-confirmable | |||||||||
| AuthorRole |
Rationale: This is a messaging artifact used by HL7 to allow the time, signiture and method to be captured when the author is not sent. This will happen in circumstances where the author information is sent as part of the authentication token. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:ROL, fixed value= "ROL"} |
|||||||||
| DataEnterer [Constraint: "
If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. "] |
Design Comments: Indicates the person responsible for entering the query into the system. Used when different from the person responsible for the request (author). For example, physician requests administrative assistant to print off a patient's medication profile. UsageNotes: This should only be specified if different from the author. Rationale: Important for audit information and determining permissions.
The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:ENT, fixed value= "ENT"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| entererChoice [1..1] (EntererChoice) | |||||||||
| EntererChoice | |||||||||
| choice of R_AssignedPersonIdentified-confirmable | |||||||||
| or R_AssigningOrganizationIdentified-confirmable | |||||||||
| DataEntryLocation [Constraint: "
If AuthorizationToken not specified, association is mandatory. If AuthorizationToken specified, association is mandatory if authorization does not cover this participation. "] |
Design Comments: Indicates the location where the record of this event was entered. UsageNotes: This should only be specified if different from the location where the event was authored. Rationale: Indicates a potential location for written records, and may also be important for authentication purposes.
The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:ELOC, fixed value= "ELOC"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| serviceDeliveryLocation [1..1] (R_ServiceDeliveryLocationMinimal) | |||||||||
| Location [Constraint: "
If AuthorizationToken not specified, association is required. If AuthorizationToken specified, association is required if authorization does not cover this participation. "] |
Design Comments: Indicates the service delivery location where the event occurred. Rationale: Indicates where paper records may be located, and may be important to determining authorization.
The association is optional because in some jurisdictions this information will be conveyed as part of the authentication token. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:LOC, fixed value= "LOC"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| serviceDeliveryLocation [1..1] (R_ServiceDeliveryLocationMinimal) | |||||||||
| Subject2 [Constraint: "
On ‘creation’ interactions (where the state transition is null->active), this must be true otherwise it must be false. "] |
Design Comments: Indicates the item(s) being acted upon by this trigger event.
Will be mandatory in wrappers with payload messages, otherwise not present. UsageNotes: If there are multiple subject items, the changes to all of them must be either accepted or rejected as a single action. I.e. One trigger event = 1 unit of work. Rationale: Provides information about the thing being created, modified or removed. |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:ON, fixed value= "ON"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL) |
Design Comments: Indicates whether or not objects of the trigger event are to be cascaded to the payload.
If true, associations in the parent act are conducted across the ActRelationship to the message payload (act). Conduction for each association is specifically indicated by each associations' contextControlCode value.
In other words, if the "subject" act relationship has contextConductionInd=true; THEN the subjectOf association is carried (to the regsitrationRequest act) according to the subjectOf.contextControlCode (AP = propogate to the reg request and add to any subject(s) (issues) already present in the payload). Rationale: Cascading of trigger event objects allows different messages to employ consistent and common objects.
Attribute is mandatory to ensure that cascading will be specified one way or another. |
||||||||
| registrationRequest [1..1] (RegistrationRequest) |
Design Comments: This class contains information relevant to the registration of the payload item(s) into the Master File or Registry. This message is a request to register. Rationale: The RegistrationProcess act is the focal act of the message and therefore is mandatory |
||||||||
| RegistrationRequest |
Design Comments: This class contains information relevant to the registration of the payload item(s) into the Master File or Registry. This message is a request to register. Rationale: The RegistrationProcess act is the focal act of the message and therefore is mandatory |
||||||||
| classCode [1..1] (M) Act (CS) {CNE:C:ActClass:REG, fixed value= "REG"} |
|||||||||
| moodCode [1..1] (M) Act (CS) {CNE:C:ActMood:RQO, fixed value= "RQO"} |
|||||||||
| statusCode [1..1] (M) Act (CS) {CNE:C:ActStatus:active, fixed value= "active"} |
|||||||||
| subject [1..1] (Subject4) |
Design Comments: Commonly called the Payload stub. Any interaction that uses this ControlAct Wrapper will replace this class with a Role-based domain Message Type Rationale: Defines the content of the registration and is therefore mandatory. |
||||||||
| custodian [1..1] (Custodian) |
Design Comments: This indicates the EHR repository the record is stored in. Rationale: Different repositories may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
||||||||
| replacementOf [0..10] (ReplacementOf) |
Design Comments: Associates a new registration which is intended to replace a registration received prior to this message. Rationale: Supports this message "replacing" a prior registration with a current regsitration (merges). |
||||||||
| Subject4 |
Design Comments: Commonly called the Payload stub. Any interaction that uses this ControlAct Wrapper will replace this class with a Role-based domain Message Type Rationale: Defines the content of the registration and is therefore mandatory. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:SBJ, fixed value= "SBJ"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AN, fixed value= "AN"} |
|||||||||
| registeredRole [1..1] (Stub "RegisteredRole") | |||||||||
| Custodian |
Design Comments: This indicates the EHR repository the record is stored in. Rationale: Different repositories may have different access rules governing access to data. Knowing the custodian of the data also helps to provide context. As a result, this association is mandatory. |
||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:CST, fixed value= "CST"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| assignedDevice [1..1] (R_AssignedDeviceRepository) | |||||||||
| ReplacementOf |
Design Comments: Associates a new registration which is intended to replace a registration received prior to this message. Rationale: Supports this message "replacing" a prior registration with a current regsitration (merges). |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:RPLC, fixed value= "RPLC"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:AN, fixed value= "AN"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL){fixed value= "false"} |
|||||||||
| priorRegistration [1..1] (PriorRegistration) |
Design Comments: This class describes the registration of a client, provider, location, etc. in the past. Rationale: Used to associate (replace) a current registration with a regsitration already received (supports merges). |
||||||||
| PriorRegistration |
Design Comments: This class describes the registration of a client, provider, location, etc. in the past. Rationale: Used to associate (replace) a current registration with a regsitration already received (supports merges). |
||||||||
| classCode [1..1] (M) Act (CS) {CNE:C:ActClass:REG, fixed value= "REG"} |
|||||||||
| moodCode [1..1] (M) Act (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| statusCode [1..1] (M) Act (CS) {CNE:C:ActStatus:obsolete, fixed value= "obsolete"} |
|||||||||
| subject [1..1] (Subject5) | |||||||||
| Subject5 | |||||||||
| typeCode [1..1] (M) Participation (CS) {CNE:C:ParticipationType:SBJ, fixed value= "SBJ"} |
|||||||||
| contextControlCode [1..1] (M) Participation (CS) {CNE:C:ContextControl:AN, fixed value= "AN"} |
|||||||||
| priorRegisteredRole [1..1] (PriorRegisteredRole) |
Design Comments: Identifies "duplicate" records of the registered item that have been superseded by this record. Rationale: Provides support for merges. |
||||||||
| PriorRegisteredRole |
Design Comments: Identifies "duplicate" records of the registered item that have been superseded by this record. Rationale: Provides support for merges. |
||||||||
| classCode [1..1] (M) Role (CS) {CNE:C:RoleClass:ROL, fixed value= "ROL"} |
|||||||||
| id [1..1] (M) Role (II.BUS) |
Design Comments: Identifies "duplicate" records of the registered item that have been superseded by this record. Rationale: Provides support for merges. |
||||||||
| PertinentInformation |
Design Comments: Identifies the authentication token that references information about the people and/or places responsible for the event. Rationale: Some systems perform centralized authentication of providers and/or locations. The association is optional because not all systems will make use of a token-based authentication process. |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:PERT, fixed value= "PERT"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL){fixed value= "false"} |
|||||||||
| authorizationToken [1..1] (AuthorizationToken) |
Design Comments: Conveys an authentication token associated with the event.
The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Rationale: Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. |
||||||||
| AuthorizationToken [Constraint: "
If specified, then the concepts covered by the token must not be specified (i.e. at least one participation of author, dataEnterer, responsibleParty, location and dataEntryLocation must not be specified) "][Constraint: "
Only one of Id or Text must be specified. "] |
Design Comments: Conveys an authentication token associated with the event.
The token may represent one or all of the following concepts: author, dataEnterer, responsibleParty, location and dataEntryLocation. Rationale: Conveys information related to the individuals and/or locations involved with the action in situations where the authentication happens on a one-time basis rather than on a per-message basis. |
||||||||
| classCode [1..1] (M) Observation (CS) {CNE:C:ActClass:VERIF, fixed value= "VERIF"} |
|||||||||
| moodCode [1..1] (M) Observation (CS) {CNE:C:ActMood:EVN, fixed value= "EVN"} |
|||||||||
| id [0..1] Observation (II.TOKEN) |
Design Comments: An authorization token expressed as a GUID.
The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Rationale: GUIDs are an effective way of conveying a temporary authentication token |
||||||||
| text [0..1] Observation (ST) |
Design Comments: An authentication token expressed as a non-GUID string.
The Authorization token may represent the concepts of author, data enterer, supervisor (responsible party), responsible location and/or data entry location. Rationale: Some systems may choose to use a hashcode or other approach to token construction. |
||||||||
| Subject3 |
Design Comments: Information pertaining to a client's (or provider's)agreement/acceptance to have his/her client/provider identification and demographic information electronically stored and shared. Rationale: Provides authorization to record and/or view client/provider information.
Indicates the consent or keyword used to authorize access or update, including a reason for access; May also be used to override access restriction to the information ('break the glass') on a message by message basis. |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL){fixed value= "false"} |
|||||||||
| consentEvent [1..1] (A_ConsentEventRegistryBasic) | |||||||||
| Subject |
Design Comments: This is the list of clinical and business issues that have been detected and/or managed involving the current action. Rationale: Any trigger event can result in errors or may allow for errors to be overridden or managed. |
||||||||
| typeCode [1..1] (M) ActRelationship (CS) {CNE:C:ActRelationshipType:SUBJ, fixed value= "SUBJ"} |
|||||||||
| contextControlCode [1..1] (M) ActRelationship (CS) {CNE:C:ContextControl:AP, fixed value= "AP"} |
|||||||||
| contextConductionInd [1..1] (M) ActRelationship (BL){fixed value= "false"} |
|||||||||
| detectedIssueEvent [1..1] (A_IssueEventManaged-basic) | |||||||||